Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(announcements): simplify changes in supported envs #4139

Merged
merged 2 commits into from
Aug 12, 2024

Conversation

MaxTru
Copy link
Contributor

@MaxTru MaxTru commented Aug 12, 2024

  • Change for consistency and readability

Description

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

* Change for consistency and readability
@MaxTru MaxTru requested a review from a team August 12, 2024 07:03
Copy link
Contributor

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/reference/announcements.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@mesellings mesellings self-requested a review August 12, 2024 07:35
@mesellings mesellings self-assigned this Aug 12, 2024
@mesellings
Copy link
Contributor

@MaxTru I'll take a look at this for you 👍

Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @MaxTru, looks good, I made some edits as follows:

  • Changed to Amazon OpenSearch rather than AWS (this is how we refer to it in the docs)
  • Added a sentence under the heading - ideally, we should always have a sentence underneath headings.
  • Front-loaded the content - i.e. put the important information at the front (e.g. changed "Raised minimum OpenJDK version..." to "OpenJDK minimum version raised" ) - helps when people scan pages for info relevant to them.
    If you're happy with these changes, let me know and I'll approve the PR 👍

@MaxTru
Copy link
Contributor Author

MaxTru commented Aug 12, 2024

Great @mesellings ! The changes make a ton of sense and really improve this section. Thank you. Let's merge.

Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MaxTru Approved 👍

@MaxTru MaxTru merged commit e4e0244 into main Aug 12, 2024
7 checks passed
@MaxTru MaxTru deleted the reformat-announcement-entries branch August 12, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants